<!DOCTYPE HTML>

<html lang="en">
<head>

<title>OAuth2TokenIntrospectionClaimAccessor (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="OAuth2TokenIntrospectionClaimAccessor (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":18,"i1":18,"i2":18,"i3":18,"i4":18,"i5":18,"i6":18,"i7":18,"i8":18,"i9":18,"i10":18,"i11":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="OAuth2TokenIntrospectionClaimAccessor.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="OAuth2TokenIntrospectionClaimAccessor.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="OAuth2TokenIntrospectionClaimAccessor.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.oauth2.core</a></div>
<h2 title="Interface OAuth2TokenIntrospectionClaimAccessor" class="title">Interface OAuth2TokenIntrospectionClaimAccessor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="ClaimAccessor.html" title="interface in org.springframework.security.oauth2.core">ClaimAccessor</a></code></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../server/resource/introspection/OAuth2IntrospectionClaimAccessor.html" title="interface in org.springframework.security.oauth2.server.resource.introspection">OAuth2IntrospectionClaimAccessor</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../server/resource/introspection/OAuth2IntrospectionAuthenticatedPrincipal.html" title="class in org.springframework.security.oauth2.server.resource.introspection">OAuth2IntrospectionAuthenticatedPrincipal</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">OAuth2TokenIntrospectionClaimAccessor</span>
extends <a href="ClaimAccessor.html" title="interface in org.springframework.security.oauth2.core">ClaimAccessor</a></pre>
<div class="block">A <a href="ClaimAccessor.html" title="interface in org.springframework.security.oauth2.core"><code>ClaimAccessor</code></a> for the &quot;claims&quot; that may be contained in the
Introspection Response.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="ClaimAccessor.html" title="interface in org.springframework.security.oauth2.core"><code>ClaimAccessor</code></a>,
<a href="OAuth2TokenIntrospectionClaimNames.html" title="interface in org.springframework.security.oauth2.core"><code>OAuth2TokenIntrospectionClaimNames</code></a>,
<a target="_blank" href="https://tools.ietf.org/html/rfc7662#section-2.2">Introspection Response</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default java.util.List&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getAudience()">getAudience</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the intended audience <code>(aud)</code> for the token</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getClientId()">getClientId</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the client identifier <code>(client_id)</code> for the token</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default java.time.Instant</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getExpiresAt()">getExpiresAt</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a timestamp <code>(exp)</code> indicating when the token expires</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getId()">getId</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the identifier <code>(jti)</code> for the token</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>default java.time.Instant</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getIssuedAt()">getIssuedAt</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a timestamp <code>(iat)</code> indicating when the token was issued</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>default java.net.URL</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getIssuer()">getIssuer</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the issuer <code>(iss)</code> of the token</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>default java.time.Instant</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getNotBefore()">getNotBefore</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a timestamp <code>(nbf)</code> indicating when the token is not to be used
before</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>default java.util.List&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getScopes()">getScopes</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the scopes <code>(scope)</code> associated with the token</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>default java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getSubject()">getSubject</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns usually a machine-readable identifier <code>(sub)</code> of the resource owner
who authorized the token</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>default java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getTokenType()">getTokenType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the type of the token <code>(token_type)</code>, for example <code>bearer</code>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>default java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#getUsername()">getUsername</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a human-readable identifier <code>(username)</code> for the resource owner that
authorized the token</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>default boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2TokenIntrospectionClaimAccessor.html#isActive()">isActive</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the indicator <code>(active)</code> whether or not the token is currently active</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.oauth2.core.ClaimAccessor">

</a>
<h3>Methods inherited from interface&nbsp;org.springframework.security.oauth2.core.<a href="ClaimAccessor.html" title="interface in org.springframework.security.oauth2.core">ClaimAccessor</a></h3>
<code><a href="ClaimAccessor.html#containsClaim(java.lang.String)">containsClaim</a>, <a href="ClaimAccessor.html#getClaim(java.lang.String)">getClaim</a>, <a href="ClaimAccessor.html#getClaimAsBoolean(java.lang.String)">getClaimAsBoolean</a>, <a href="ClaimAccessor.html#getClaimAsInstant(java.lang.String)">getClaimAsInstant</a>, <a href="ClaimAccessor.html#getClaimAsMap(java.lang.String)">getClaimAsMap</a>, <a href="ClaimAccessor.html#getClaimAsString(java.lang.String)">getClaimAsString</a>, <a href="ClaimAccessor.html#getClaimAsStringList(java.lang.String)">getClaimAsStringList</a>, <a href="ClaimAccessor.html#getClaimAsURL(java.lang.String)">getClaimAsURL</a>, <a href="ClaimAccessor.html#getClaims()">getClaims</a>, <a href="ClaimAccessor.html#hasClaim(java.lang.String)">hasClaim</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="isActive()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>isActive</h4>
<pre class="methodSignature">default&nbsp;boolean&nbsp;isActive()</pre>
<div class="block">Returns the indicator <code>(active)</code> whether or not the token is currently active</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the indicator whether or not the token is currently active</dd>
</dl>
</li>
</ul>
<a id="getUsername()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsername</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.lang.String&nbsp;getUsername()</pre>
<div class="block">Returns a human-readable identifier <code>(username)</code> for the resource owner that
authorized the token</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a human-readable identifier for the resource owner that authorized the
token</dd>
</dl>
</li>
</ul>
<a id="getClientId()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientId</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.lang.String&nbsp;getClientId()</pre>
<div class="block">Returns the client identifier <code>(client_id)</code> for the token</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the client identifier for the token</dd>
</dl>
</li>
</ul>
<a id="getScopes()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getScopes</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getScopes()</pre>
<div class="block">Returns the scopes <code>(scope)</code> associated with the token</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the scopes associated with the token</dd>
</dl>
</li>
</ul>
<a id="getTokenType()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getTokenType</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.lang.String&nbsp;getTokenType()</pre>
<div class="block">Returns the type of the token <code>(token_type)</code>, for example <code>bearer</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the type of the token, for example <code>bearer</code>.</dd>
</dl>
</li>
</ul>
<a id="getExpiresAt()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpiresAt</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.time.Instant&nbsp;getExpiresAt()</pre>
<div class="block">Returns a timestamp <code>(exp)</code> indicating when the token expires</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a timestamp indicating when the token expires</dd>
</dl>
</li>
</ul>
<a id="getIssuedAt()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getIssuedAt</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.time.Instant&nbsp;getIssuedAt()</pre>
<div class="block">Returns a timestamp <code>(iat)</code> indicating when the token was issued</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a timestamp indicating when the token was issued</dd>
</dl>
</li>
</ul>
<a id="getNotBefore()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getNotBefore</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.time.Instant&nbsp;getNotBefore()</pre>
<div class="block">Returns a timestamp <code>(nbf)</code> indicating when the token is not to be used
before</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a timestamp indicating when the token is not to be used before</dd>
</dl>
</li>
</ul>
<a id="getSubject()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubject</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.lang.String&nbsp;getSubject()</pre>
<div class="block">Returns usually a machine-readable identifier <code>(sub)</code> of the resource owner
who authorized the token</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>usually a machine-readable identifier of the resource owner who authorized
the token</dd>
</dl>
</li>
</ul>
<a id="getAudience()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getAudience</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getAudience()</pre>
<div class="block">Returns the intended audience <code>(aud)</code> for the token</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the intended audience for the token</dd>
</dl>
</li>
</ul>
<a id="getIssuer()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getIssuer</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.net.URL&nbsp;getIssuer()</pre>
<div class="block">Returns the issuer <code>(iss)</code> of the token</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the issuer of the token</dd>
</dl>
</li>
</ul>
<a id="getId()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getId</h4>
<pre class="methodSignature">@Nullable
default&nbsp;java.lang.String&nbsp;getId()</pre>
<div class="block">Returns the identifier <code>(jti)</code> for the token</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the identifier for the token</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="OAuth2TokenIntrospectionClaimAccessor.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="OAuth2TokenIntrospectionClaimAccessor.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="OAuth2TokenIntrospectionClaimAccessor.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040f4e0ecad97cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
